Hybris UX Api

(0 reviews)

GET Appointment

GET

This Operation is used to get the booked technician appointment details based on the Order id.

Request

This section defines all the possible data structures sent by the client when consuming the method.

URL

https://[localhost]:[port]/ecom-ux/v1/PR/appointment

URL PARAMS

name	type	description	required
businessId	string	2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit. Enum values: BS-Bahamas CO-Colombia CO1-Colombia Zona Franca CL-Chile CR-Costa Rica DO-Dominican Republic GT-Guatemala HN-Honduras JM-Jamaica PA-Panama PR-Puerto Rico SV-Salvador	Y

Query Params

name	type	description	required
orderId	string	Need to pass valid order id of customer	Y

name	value	description	required
client-id	string	The client_id identifying the channel. Minimum characters: 5	Y
client-secret	string	Password associated with the client_id. Minimum characters: 5	Y
X-Correlation-ID	string	Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.	N It is Mandatory for business
channelId	string	Channel to business:Expected Value: "ECOM" Note ChannelId default value: ECOM	N
lob	string	The Line of Business Identifier currently available are: FIXED enum: ["FIXED", "PREPAID", "POSTPAID"]	N

Response

In this section all the possible data structures received by the client at the moment of responding the method are defined.

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

[ 200 ]

Created - Resource created successfully, response body contains an entity corresponding to the requested resource.

[
    {
        "id": "12000435890710140001",
        "status": "X",
        "externalId": "000000",
        "description": "FTTH INSTALL",
        "category": "C",
        "creationDate": "2022-09-30T15:45:38Z",
        "lastUpdate": "2022-11-21T15:58:37Z",
        "validFor": {
            "startDateTime": "2022-10-03T08:00:00Z",
            "endDateTime": "2022-10-03T12:00:00Z"
        },
        "relatedParty": [
            {
                "role": "Technician",
                "id": "0701",
                "@referredType": "Technician"
            },
            {
                "role": "Sales Representative",
                "id": "12345",
                "@referredType": "Sales Representative"
            },
            {
                "role": "Customer",
                "id": "1901504956721",
                "@referredType": "Customer"
            }
        ],
        "relatedPlace": {
            "id": "00917000001706",
            "role": "InstallationAddress"
        },
        "relatedEntity": [
            {
                "id": "1200043589071014",
                "name": "OrderId"
            }
        ],
        "note": [
            {
                "text": "A",
                "@type": "controlMethod"
            },
            {
                "text": "MA",
                "@type": "OrderReasonCode"
            },
            {
                "text": "000",
                "@type": "CampaignCode"
            },
            {
                "text": "FN",
                "@type": "JobType"
            }
        ],
        "@type": "Appointment"
    }
]

LCPR Example:

[
    {
        "id": "12000522476910140001",
        "status": "R",
        "externalId": "112368",
        "description": "NEW CONNECT",
        "category": "C",
        "creationDate": "2023-10-04T09:20:58.000-04:00",
        "lastUpdate": "2023-10-04T10:39:19.000-04:00",
        "validFor": {
            "startDateTime": "2023-10-06T08:00:00.000-04:00",
            "endDateTime": "2023-10-06T12:00:00.000-04:00"
        },
        "relatedParty": [
            {
                "role": "Technician",
                "id": "1000",
                "@referredType": "Technician"
            },
            {
                "role": "Sales Representative",
                "id": "54321",
                "@referredType": "Sales Representative"
            },
            {
                "role": "Customer",
                "id": "1901510046913",
                "@referredType": "Customer"
            }
        ],
        "relatedPlace": {
            "id": "00917000000963",
            "role": "InstallationAddress"
        },
        "relatedEntity": [
            {
                "id": "1200052247691014",
                "name": "OrderId"
            }
        ],
        "note": [
            {
                "text": "A",
                "@type": "ControlMethod"
            },
            {
                "text": "E1",
                "@type": "OrderReasonCode"
            },
            {
                "text": "ECO",
                "@type": "CampaignCode"
            },
            {
                "text": "NC",
                "@type": "JobType"
            }
        ],
        "@type": "Appointment"
    }
]

Possible response error

In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

{
  "errors" : [{
      "code" : 400 ,
      "message" : "The request is invalid or not properly formed.",
      "description" : "The client sent too many requests and server is not able to serve them all at the moment"
    }
  ]
}

[ 501 ]

Not implemented - indicates that the server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.

{
  "errors" : [{
      "code" : 501,
      "message" : "NOT IMPLEMENTED",
      "description" : "Operation GET /reset for Business Id: PR not implemented"
    }
  ]
  }

Definitions

Each of the request parameters is detailed.

name	type	description	required
id	string	Unique identifier	Y
status	string	Status of the appointment	Y
externalId	string	Defines Job Number	Y
description	string	Defines the type of the appointment	Y
category	string	Contains the job class. Reffer below Class table	N
creationDate	string	Concatinating Date and Time When the appointment was created	Y
lastUpdate	string	Concatinating Date and Time When the changes were made	N
validFor.startDateTime	string	Defines the start date time of appointment	N
validFor.endDateTime	string	Defines the end date time of appointment	N
relatedParty[].id	string	Customer ID	Y
relatedParty[].name	string	Defines the Customer Name with Salutation	Y
role	string	Static Content as 'Customer'	Y
@referredType	string	Static Content as 'Individual'	Y
relatedParty[].id	string	Defines the Technician Id	Y
relatedParty[].href	string	Hyperlink	N
role	String	Static Content as 'technician'	Y
@referredType	string	Static Content as 'Individual'	Y
relatedParty[].id	string	Static content Sales Representative	Y
role	string	Static Content as 'Sales Representative'	Y
@referredType	string	Static Content as 'Individual'	Y
RelatedPlace.id	string	Defines the customer location Id	Y
RelatedPlace.role	string	Static Content as 'locationId'	Y
relatedEntity[].id	string	Defines the customer order id	Y
relatedEntity[].name	string	Static Content as 'Order Id'	Y
note[].text	string	Reffer below Control Method table, CampaignCode, OrderReasonCode, JobType	N
note[].@type	string	Static Content	N
@type	string	Static Content as "Appointment"	N

CLASS:

*Contains the job class. Valid values are as follows:

Type	Description
C	New connect
D	Disconnect
R	Restart service
S	Service change
T	Trouble call
Z	Special request

ControlMethod:

Identifies the control type. Valid values are as follows:

Type	Description
A	Automatic; the job is automatically assigned
K	Keep; the job is not changed
M	Manual; the job is manually assigned
U	Updated the job is updated